Variables par défaut

Variables système - Le protocole par défaut permet de créer des variables qui pointent vers les variables système de l'IMH concernant :

 

Paramètres de l’éditeur du protocole

Dans la liste des modèles d'API de la boîte de dialogue Éditeur de protocole, sélectionnez Défaut.

 

Paramètres de l’éditeur de variables

Chemin : VueProjet> Configuration > double-cliquez sur Variables

  1. Pour ajouter une variable, cliquez sur + : une nouvelle ligne est ajoutée.
  2. Sélectionnez Variables système dans la liste Driver : le dialogue de définition de variables s'affiche.

Élément Description

Type de mémoire

Représente la variable système à laquelle la variable renvoie. 

La rubrique ci-dessous montre la liste complète des variables système possibles, regroupées par catégorie.

Variables d'alarmes
Nom de variable Description Type de données
Alarm not acknowledged

Vrai quand les alarmes non confirmées sont en attente

(Non déclenchée Non confirmée<>0) OU (Déclenchée Non confirmée<>0)

booléen

Lecture seule

Alarm triggered

Vrai quand au moins une alarme a été déclenchée

(Déclenchée Confirmée<>0) OU (Déclenchée<>0) OU (Déclenchée Non confirmée<>0)

booléen

Lecture seule

Number of missed alarm events Alarmes dépassant la file d'attente des événements. La longueur de la file d'attente est définie dans le fichier engineconfig.xml.

int

Lecture seule

Number of not triggered acknowledged Alarmes désactivées ; alarmes déjà confirmées

int

Lecture seule

Number of not triggered not acknowledged Alarmes désactivées ; en attente de confirmation

int

Lecture seule

Number of triggered acknowledged Alarmes actives ; alarmes déjà confirmées

int

Lecture seule

Number of triggered alarms Alarme active : confirmation non requise

int

Lecture seule

Number of triggered not acknowledged Alarmes actives ; en attente de confirmation

int

Lecture seule

Variables du vibreur sonore
Nom de variable Description Type de données
Buzzer Setup

0 = désactivé

1 = activé (le vibreur sonore est audible pour tous les événements de l'écran tactile)

2 = statut du vibreur commandé par la variable système Commande vibreur ou par la propriété Vibreur au toucher dans les « Propriétés du projet » du manuel principal

 

Le vibreur sur l'écran tactile (Réglage = 1) n’est pas disponible sur les plateformes Linux. Voir la propriété « Vibreur au toucher » comme alternative.

int

Buzzer Control

0 = vibreur éteint

1 = vibreur allumé

2 = vibreur clignotant

int

Buzzer Off Time Durée en millisecondes du temps de silence du vibreur lorsque le clignotement a été sélectionné. Défaut = 1000. Plage : 100–5000

int

Buzzer On Time Durée en millisecondes du temps d'activation du vibreur lorsque le clignotement a été sélectionné. Défaut = 1000. Plage : 100–5000

int

Variables de communication
Nom de variable Description Type de données
Protocol Communication Status

Résume l'état des protocoles de communication.

0 = Aucun protocole en cours d'exécution, il est possible que les pilotes des protocoles n'aient pas été téléchargés correctement sur le périphérique IHM.

1 = Protocoles chargés et démarrés, aucune erreur de communication.

2 = Au moins un protocole de communication signal une erreur.

int

Lecture seule

Protocol Error Message

Erreur de communication avec source de l'erreur.

Par exemple : « [xxxx] » où « xxxx » est l'abréviation du protocole, source de l'erreur.

Plusieurs acronymes apparaissent dans le cas de sources d'erreurs multiples. Vide lorsqu'aucune erreur n'est signalée.

chaîne

Lecture seule

Protocol Error Count Nombre d'erreurs de communication survenues depuis la dernière réinitialisation. Réinitialisez la valeur avec l'action Réinitialiser le nombre d'erreurs du protocole, voir « Actions système » du manuel principal.

int

Lecture seule

Variables bases de données
Nom de variable Description Type de données
Database link error message

Description de la dernière erreur détectée

chaîne

Lecture seule

Database link status

0 = Non défini (pas encore initialisé)0 = Non défini (pas encore initialisé)

1 = EnLigne (prêt)

2 = HorsLigne (non disponible)

3 = Transfert en cours

4 = Erreur

int

Lecture seule

Database link error count Compteur d'erreurs. Augmente après chaque erreur

int

Lecture seule

Chaque variable de base de données est un tableau où l'index sélectionne la connexion de lien de base de données (plage 1 à 10)
Les variables sont mises à jour uniquement lorsqu'une action de connecteur de base de données est exécutée

Variables de passage à l'heure d'été
Nom de variable Description Type de données
Standard Offset Décalage en minutes par rapport au GMT lorsque l'heure est réglée sur l'heure standard (par exemple : -8x60 = -480 minutes)

int

Lecture seule

Standard Week Semaine à laquelle l'heure standard commence (par exemple : Premier = 1)

int

Lecture seule

Standard Month Mois auquel le passage à l'heure d'été commence. Plage : 0-11 (Par exemple : Novembre = 10)

int

Lecture seule

Standard Day Jour de la semaine auquel l'heure standard commence (par exemple : Dimanche = 0)

int

Lecture seule

Standard Hour Heure à laquelle l'heure standard commence (par exemple : 02 = 2)

int

Lecture seule

Standard Minute Minute à laquelle l'heure standard commence (par exemple : 00 = 0)

int

Lecture seule

DST Offset Décalage en minutes par rapport au GMT lorsque le passage à l'heure est défini

int

Lecture seule

DST Week Semaine à laquelle le passage à l'heure d'été commence

int

Lecture seule

DST Month Mois auquel le passage à l'heure d'été commence. Plage : 0–11

int

Lecture seule

DST Day Jour de la semaine auquel le passage à l'heure d'été commence

int

Lecture seule

DST Hour Heure à laquelle le passage à l'heure d'été commence

int

Lecture seule

DST Minute Minute à laquelle le passage à l'heure d'été commence

int

Lecture seule

Toutes les variables sont en lecture seule ; il n'est pas possible de les utiliser pour mettre à jour l'horloge système.

Variables de périphériques
Nom de variable Description Type de données
Available System Memory Mémoire RAM libre en octets

uint64

Lecture seule

Backlight Time Temps d'activation en heures du rétroéclairage de l'affichage depuis la fabrication du périphérique

entier non signé

Lecture seule

Battery LED

Active/désactive le voyant de batterie faible de la DEL (si disponible)

0 = désactivé

1 = activé

Non disponible sur les plateformes Linux (trouvez la plateforme de votre périphérique au chapitre "Capacités des périphériques IHM"

int

Display Brightness

Réinitialise et adapte le niveau de luminosité.

Lorsque le rétroéclairage est réglé sur un niveau de luminosité faible (0...3), il reste allumé à un niveau plus élevé pendant 8 secondes afin de permettre à l'utilisateur d'effectuer les réglages, puis il s'éteint.

Même lorsqu'il est réglé sur 0, le rétroéclairage reste allumé et le compteur Durée de rétroéclairage augmente. Plage : 0–255

int

External Timeout

Délai d'inactivité après lequel le rétroéclairage de l'écran s'éteint automatiquement. Le rétroéclairage s'allume automatiquement dès que l'utilisateur touche l'écran.

-1 =

Éteint le rétroéclairage et désactive les commandes tactiles (éteindre l'affichage). Le compteur Backlight Time s'arrête.

, BSP v1.0.324 ou supérieur est requis.

-2 =

Éteint le rétroéclairage mais ne désactive pas le toucher. Si vous appuyez sur la touche, l'événement n'est pas transmis aux applications mais l'écran de veille se ferme et le rétro-éclairage s'allume.

BSP v1.0.324 ou plus est requis.

0 = Allumer le rétroéclairage (allume l'affichage)
1..n =

Délai d'attente, en secondes, pour éteindre le rétroéclairage (minuteur de l'écran de veille)

La valeur du délai d'attente est arrondie à des multiples d'une minute (60, 120, 180, etc.).

Trouvez la plate-forme de votre périphérique en "Capacités des périphériques IHM".

int

Flash Free Space Espace flash libre restant dans la mémoire flash interne

uint64

Lecture seule

Manufacturer Code Numéro de code identifiant l'IHM

court

Lecture seule

Server RAM Usage Mémoire RAM actuelle utilisée par l'IHM, exprimée en octets

uint64

Lecture seule

System Font List Liste des polices du système

chaîne

Lecture seule

System Mode

État de service du runtime.

1 = démarrage en cours

2 = mode de configuration

3 = mode opérationnel

4 = redémarrage

5 = arrêt

int

System UpTime Durée pendant laquelle le système a été alimenté depuis la fabrication de l'unité (en heures)

entier non signé

Lecture seule

Variables informations de vidage
Nom de variable Description Type de données
Dump Error Message Retour du message d'erreur si une erreur se produit pendant l'opération de vidage

chaîne

Lecture seule

Dump Archive Status

0 = état initial par défaut
1 = opération déclenchée
2 = opération terminée avec succès
3 = opération terminée avec erreurs

int

Lecture seule

Dump Recipe Status

0 = état initial par défaut
1 = opération déclenchée
2 = opération terminée avec succès
3 = opération terminée avec erreurs

int

Lecture seule

Dump Trend Status

0 = état initial par défaut
1 = opération déclenchée
2 = opération terminée avec succès
3 = opération terminée avec erreurs

int

Lecture seule

Reset Recipe Status

0 = état initial par défaut
1 = opération déclenchée
2 = opération terminée avec succès
3 = opération terminée avec erreurs

int

Lecture seule

Restore Recipe Status

0 = état initial par défaut
1 = opération déclenchée
2 = opération terminée avec succès
3 = opération terminée avec erreurs

int

Lecture seule

Variables réseau
Nom de variable Description Type de données
Gateway

Adresse de passerelle de l'interface Ethernet principale de l'IHM

chaîne

Lecture seule

IP Address

Adresse IP de l'interface Ethernet principale de l'IHM

chaîne

Lecture seule

Mac ID ID Mac de l'interface Ethernet principale de l'IHM

chaîne

Lecture seule

Network Adapter Parameters Chaîne JSON qui permet de lire ou de mettre à jour les paramètres de l'adaptateur réseau

chaîne

Network Status

Contient les résultats de la dernière opération requise par l'écriture dans les Paramètres de l'adaptateur. Cette valeur est actualisée après chaque opération d'écriture.

  • Si la chaîne est vide, cela signifie qu'il n'y a aucune erreur
  • Descriptions des erreurs les plus récentes

chaîne

Lecture seule

Subnet Mask Masque de sous réseau de l'interface Ethernet principale de l'IHM

chaîne

Lecture seule

Variables d’API
Nom de variable Description Type de données
Get CopyCodesysProject Action Status

Indique le statut de l'action CopyCodesysProject.

0 = Action non appelée

1 = Action en cours

2 = Action terminée

3 = Action échouée (fichier CHK manquant)

4 = Action échouée (fichier PRJ manquant)

5 = Action échouée (fichier SDB manquant)

6 = Action échouée (plusieurs fichiers CHK trouvés)

7 = Action échouée (plusieurs fichiers PRJ trouvés)

8 = Action échouée (plusieurs fichiers SDB trouvés)

9 = Action échouée (noms de fichiers contradictoires)

10 = Action échouée (impossible de créer le répertoire)

11 = Action échouée (échec de la copie)

12 = Action interrompue (module Codesys absent)

int

Lecture seule

PLC Status

Indique le statut de l'API interne

0 = mode Exécution

1 = mode Arrêt

2 = Recharger à partir de fichier

3 = Redémarrer à chaud

4 = Redémarrer à froid

5 = Réinitialisation matérielle

int

Les variables système de l'API renvoient à CODESYS V2 API interne

Variables écran
Nom de variable Description Type de données
X Screen resolution Affiche la dimension horizontale de l'écran en pixels

int

Lecture seule

Y Screen resolution

Affiche la dimension verticale de l'écran en pixels

int

Lecture seule

Variables carte SD
Nom de variable Description Type de données
SD Card FreeSpace

Espace de mémoire libre sur la carte en octets

uint64

Lecture seule

SD Card Name Nom de la carte SD

chaîne

Lecture seule

SD Card Size Tailles en octets de la carte enfichée dans le port

uint64

Lecture seule

SD Card Status

0 = carte SD débranchée

1 = carte SD branchée

int

Lecture seule

Variables serveur
Nom de variable Description Type de données
Page name Nom de la page actuellement affichée

chaîne

Lecture seule

Project Name Nom du projet actuel

chaîne

Lecture seule

Project load time Date de chargement du projet sur le JMobile HMI Runtime au format Date système (millisecondes).

uint64

Lecture seule

Last operating mode start time

Secondes écoulées depuis que le périphérique a démarré en mode opérationnel

uint64

Lecture seule

Toutes les variables se référent au serveur, non à HMI Client.

Variables d’heure
Nom de variable Description Type de données
Day Of Month Plage : 1–31

int

Day of Week

Plage : 0 = Dimanche, .. , 6 = Samedi

int

Hour Plage : 0–23

int

Minute Plage : 0–59

int

Month

Plage : 1–12

int

Second

Plage : 0–59

int

System Time Identique à l'heure UTC. Il est également possible de définir cette variable au format date/heure. entier non signé
Year Année en cours int

Heure système au format UTC

Variables lecteur USB
Nom de variable Description Type de données
USB Drive FreeSpace Espace de mémoire libre en octets

uint64

Lecture seule

USB Drive Name

Nom du périphérique USB

chaîne

Lecture seule

USB Drive Size Taille en octets du lecteur branché au port USB

uint64

Lecture seule

USB Drive Status

0 = lecteur USB débranché

1 = lecteur USB branché

int

Lecture seule

Variables de version
Nom de variable Description Type de données
Main OS version Version principale du SE

chaîne

Lecture seule

Runtime version

Version du runtime

chaîne

Lecture seule

Project name Nom du projet

chaîne

Lecture seule

Project version Version de projet

chaîne

 

Project GUID GUID du Projet (identificateur unique)

chaîne

Lecture seule

Variables du commutateur de communication virtuelle
Nom de variable Description Type de données
VCS status

Indique le statut du périphérique VCS.

0 = Service activé

1 = Client connecté en mode intercalé

2 = Client connecté en mode exclusif

3 = Service désactivé (par défaut)

octet non signé

Lecture seule

VCS disable

Permet la désactivation manuelle du périphérique VCS.

0 = Service VCS activé

1 = Service VCS désactivé (par défaut)

booléen

VCS port Indique le port d'écoute en cours TCP sur l'IHM par le service VCS court non signé

 

Type de données

Chaque variable système a un type de données spécifique, décrit dans les tableaux ci-dessus.

Le tableau suivant présente les détails de tous les types de données utilisés pour les variables système.

Type de données Espace mémoire Limites
court Donnée à 16 bits -32768 ... 32767
int Donnée à 32 bits -2.1e9 ... 2.1e9
octet non signé Donnée à 8 bits 0 ... 255
court non signé Donnée à 16 bits 0 ... 65535
entier non signé Donnée à 32 bits 0 ... 4.2e9
uint64 Donnée à 64 bits 0 ... 1.8e19
chaîne Tableau des éléments contenant du code de caractères défini par l'encodage sélectionné

Taille de tableau

En cas de variable de chaîne, cette propriété représente le nombre maximum d’octets disponible pour la variable de chaîne.

Remarque : le nombre d'octets correspond au nombre de caractères de chaîne si la propriété Encoding est définie sur UTF-8 ou Latin1 dans l'Éditeur de variables.
Si la propriété Encoding est définie sur UCS-2BE, UCS-2LE, UTF-16BE ou UTF-16LE, un caractère nécessite 2 octets.

Conversion

Conversion à appliquer à la variable.

En fonction du type de données choisi, la liste Autorisée affiche un ou plusieurs types de conversion.

Valeur Description
Inv bits

inv : Inverse tous les bits de la variable.

Exemple :
1001 → 0110 (format binaire)
9 → 6 (format décimal)

Negate

neg : Inverse la valeur de la variable.

Exemple :
25.36 → -25.36

AB -> BA

swapnibbles : Échange les quartets d’un octet.

Exemple :
15D4 → 514D (format hexadécimal)
5588 → 20813 (format décimal)

ABCD -> CDAB

swap2 : Échange les octets d’un mot.

Exemple :
9ACC → CC9A (format hexadécimal)
39628 → 52378 (format décimal)

ABCDEFGH -> GHEFCDAB

swap4 : Échange les octets dans un double mot.

Exemple :
32FCFF54 → 54FFFC32 (format hexadécimal)
855441236 → 1426062386 (format décimal)

ABC...NOP -> OPM...DAB

swap8 : Échange les octets dans un long mot.

Exemple :
142,366 → -893553517,588905 (format décimal)
0 10000000110 0001110010111011011001000101101000011100101011000001

1 10000011100 1010101000010100010110110110110010110110000100111101
(format binaire)

BCD

bcd : sépare l’octet en deux quartets, les lit au format décimal (de 0 à 9)

Exemple :
23 → 17 (format décimal)
0001 0111 = 23
0001 = 1 (premier quartet)
0111 = 7 (second quartet)

Sélectionnez la conversion et cliquez sur le bouton +. La conversion sélectionnée s’affiche dans la liste Configurée.

Si vous configurez d’autres conversions, celles-ci s’affichent dans l’ordre (du haut vers le bas de la liste Configurée).

Utilisez les boutons de direction pour changer l’ordre des conversions configurées.